Sphinx (documentation generator)

Sphinx
Developer(s) Georg Brandl
Initial release March 21, 2008 (2008-03-21)
Stable release 1.1.2 / November 1, 2011; 3 months ago (2011-11-01)
Written in Python
Operating system Cross-platform
Type Documentation generator
License BSD
Website sphinx.pocoo.org

Sphinx is a documentation generator which converts reStructuredText files into HTML websites and other formats including PDF, EPub and man. It exploits the extensible nature of reStructuredText through a number of extensions (e.g. for autogenerating documentation from source code, writing mathematical notation or highlighting source code). The first public release, version 0.1.61611, was announced on March 21, 2008[1]. It was developed for, and used extensively by, the Python project for documentation[2].

Since its introduction in 2008, Sphinx was adopted by many other important Python projects, such as Bazaar, SQLAlchemy, MayaVi, Sage, SciPy, Django and Pylons; it is also used for the Blender Python API documentation[3]. In an effort to make maintenance of software documentation easier, the Read the Docs project was created[4]. It automates the process of building and uploading Sphinx documentation after every commit. It is sponsored by the Python Software Foundation[5].

See also

References

  1. ^ "Sphinx is released! » And now for something completely Pythonic...". And now for something completely Pythonic.... Georg Brandl. http://pythonic.pocoo.org/2008/3/21/sphinx-is-released. Retrieved 2011-04-03. 
  2. ^ "About these documents — Python v2.7.1 documentation". Python documentation. Python Software Foundation. http://docs.python.org/about.html. Retrieved 2011-04-03. 
  3. ^ "Dev:2.5/Py/API/Generating API Reference - BlenderWiki!". Blender Wiki. Blender Foundation. http://wiki.blender.org/index.php/Dev:2.5/Py/API/Generating_API_Reference. Retrieved 2011-04-06. 
  4. ^ "Announcing Read The Docs". Surfing in Kansas. Eric Holscher. http://ericholscher.com/blog/2010/aug/16/announcing-read-docs/. Retrieved 2011-04-06. 
  5. ^ "Python Software Foundation News: PSF Funds readthedocs.org". Python Software Foundation News. Python Software Foundation. http://pyfound.blogspot.com/2011/03/psf-funds-readthedocsorg.html. Retrieved 2011-04-06. 

External links